Fzzy Config/me.fzzyhmstrs.fzzy_config.util/ValidationResult

ValidationResult

A result of any type T that is wrapped with an optional error message

Used to provide contextual error information "upstream" of where the error was encountered, which allows for better logging where upstream elements can collate error messages passed back to them into an organized and sensible error log.

This class has a private constructor to force the use of the pre-defined static instantiation methods

Author

fzzyhmstrs

Since

0.1.0

Parameters

result type, can be nullable

Types

Companion

object Companion

Functions

also

fun <T> ValidationResult<T>.also(newTest: Boolean, error: String): ValidationResult<T>

Adds another test, and potentially another error, to a Validation.

contextualize

fun <T : Any> ValidationResult<ConfigContext<T>>.contextualize(): ValidationResult<T>

get

fun get(): T

Gets the wrapped result value

getError

fun getError(): String

Supplies the error message stored within

isError

fun isError(): Boolean

Boolean check to determine if this result is holding an error

isValid

fun isValid(): Boolean

Boolean check to determine if this result is valid (no errors)

map

fun <N, T> ValidationResult<T>.map(to: Function<T, out N>): ValidationResult<N>

report

fun <T> ValidationResult<T>.report(errorReporter: Consumer<String>): ValidationResult<T>

reports error, if any, to a provided reporter (such as a logger)

fun <T> ValidationResult<T>.report(errorBuilder: MutableList<String>): ValidationResult<T>

reports error, if any, to a provided string list

wrap

fun <T> ValidationResult<*>.wrap(newVal: T): ValidationResult<T>

Creates a new ValidationResult of type T wrapping the new value with the error(if any) from the receiver ValdiationResult (of any type, does not need to match T)

writeError

fun writeError(errors: List<String>)

Writes an error log to console if this validation result is errored

writeWarning

fun writeWarning(errors: List<String>)

Writes a warning log to console if this validation result is errored